<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2012 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: PersistentObjectDelegate.html 689 2013-06-28 19:22:16Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.pobj;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.io.IOException;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.util.Set;<a name="line.11"></a>
<span class="sourceLineNo">012</span><a name="line.12"></a>
<span class="sourceLineNo">013</span>import javax.validation.ConstraintViolation;<a name="line.13"></a>
<span class="sourceLineNo">014</span>import javax.xml.transform.Result;<a name="line.14"></a>
<span class="sourceLineNo">015</span>import javax.xml.transform.Source;<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>/**<a name="line.17"></a>
<span class="sourceLineNo">018</span> * Delegate interface required for {@link PersistentObject}s.<a name="line.18"></a>
<span class="sourceLineNo">019</span> * Instances provide methods for converting to/from XML, validation, etc.<a name="line.19"></a>
<span class="sourceLineNo">020</span> *<a name="line.20"></a>
<span class="sourceLineNo">021</span> * @param &lt;T&gt; type of the root persistent object<a name="line.21"></a>
<span class="sourceLineNo">022</span> * @see PersistentObject<a name="line.22"></a>
<span class="sourceLineNo">023</span> */<a name="line.23"></a>
<span class="sourceLineNo">024</span>public interface PersistentObjectDelegate&lt;T&gt; {<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>    /**<a name="line.26"></a>
<span class="sourceLineNo">027</span>     * Serialize a root object graph into XML.<a name="line.27"></a>
<span class="sourceLineNo">028</span>     *<a name="line.28"></a>
<span class="sourceLineNo">029</span>     * &lt;p&gt;<a name="line.29"></a>
<span class="sourceLineNo">030</span>     * Note that this method effectively defines what is contained in the object graph<a name="line.30"></a>
<span class="sourceLineNo">031</span>     * rooted at {@code obj}.<a name="line.31"></a>
<span class="sourceLineNo">032</span>     *<a name="line.32"></a>
<span class="sourceLineNo">033</span>     * &lt;p&gt;<a name="line.33"></a>
<span class="sourceLineNo">034</span>     * This method must not modify {@code obj} or any other object in its object graph.<a name="line.34"></a>
<span class="sourceLineNo">035</span>     *<a name="line.35"></a>
<span class="sourceLineNo">036</span>     * @param obj object to serialize; must not be modified<a name="line.36"></a>
<span class="sourceLineNo">037</span>     * @param result XML destination<a name="line.37"></a>
<span class="sourceLineNo">038</span>     * @throws PersistentObjectException if an error occurs<a name="line.38"></a>
<span class="sourceLineNo">039</span>     */<a name="line.39"></a>
<span class="sourceLineNo">040</span>    void serialize(T obj, Result result) throws IOException;<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span>    /**<a name="line.42"></a>
<span class="sourceLineNo">043</span>     * Deserialize a root object graph from XML.<a name="line.43"></a>
<span class="sourceLineNo">044</span>     *<a name="line.44"></a>
<span class="sourceLineNo">045</span>     * &lt;p&gt;<a name="line.45"></a>
<span class="sourceLineNo">046</span>     * This method also presents an opportunity to (re)construct any indexes used for optimizing queries<a name="line.46"></a>
<span class="sourceLineNo">047</span>     * into the root object graph.<a name="line.47"></a>
<span class="sourceLineNo">048</span>     *<a name="line.48"></a>
<span class="sourceLineNo">049</span>     * @param source XML source<a name="line.49"></a>
<span class="sourceLineNo">050</span>     * @return deserialized object<a name="line.50"></a>
<span class="sourceLineNo">051</span>     * @throws PersistentObjectException if an error occurs<a name="line.51"></a>
<span class="sourceLineNo">052</span>     */<a name="line.52"></a>
<span class="sourceLineNo">053</span>    T deserialize(Source source) throws IOException;<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span>    /**<a name="line.55"></a>
<span class="sourceLineNo">056</span>     * Make a deep copy of the given object.<a name="line.56"></a>
<span class="sourceLineNo">057</span>     *<a name="line.57"></a>
<span class="sourceLineNo">058</span>     * &lt;p&gt;<a name="line.58"></a>
<span class="sourceLineNo">059</span>     * For correct behavior, this behavior of this method should be equivalent to a<a name="line.59"></a>
<span class="sourceLineNo">060</span>     * {@linkplain #serialize serialization} followed by a {@linkplain #deserialize deserialization}.<a name="line.60"></a>
<span class="sourceLineNo">061</span>     *<a name="line.61"></a>
<span class="sourceLineNo">062</span>     * &lt;p&gt;<a name="line.62"></a>
<span class="sourceLineNo">063</span>     * This method must not modify {@code original} or any other object in its object graph.<a name="line.63"></a>
<span class="sourceLineNo">064</span>     *<a name="line.64"></a>
<span class="sourceLineNo">065</span>     * @throws IllegalArgumentException if {@code original} is null<a name="line.65"></a>
<span class="sourceLineNo">066</span>     * @throws PersistentObjectException if an error occurs<a name="line.66"></a>
<span class="sourceLineNo">067</span>     */<a name="line.67"></a>
<span class="sourceLineNo">068</span>    T copy(T original);<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span>    /**<a name="line.70"></a>
<span class="sourceLineNo">071</span>     * Attempt to determine whether two object graphs are identical.<a name="line.71"></a>
<span class="sourceLineNo">072</span>     *<a name="line.72"></a>
<span class="sourceLineNo">073</span>     * &lt;p&gt;<a name="line.73"></a>
<span class="sourceLineNo">074</span>     * This optional method is an optimization to detect invocations to {@link PersistentObject#setRoot PersistentObject.setRoot()}<a name="line.74"></a>
<span class="sourceLineNo">075</span>     * where the new object graph and the old object graph are identical. In such cases, no change is applied,<a name="line.75"></a>
<span class="sourceLineNo">076</span>     * the version number does not increase, and no notifications are sent.<a name="line.76"></a>
<span class="sourceLineNo">077</span>     *<a name="line.77"></a>
<span class="sourceLineNo">078</span>     * &lt;p&gt;<a name="line.78"></a>
<span class="sourceLineNo">079</span>     * It is always safe and correct for this method to return false. If it returns true, then it must be the case<a name="line.79"></a>
<span class="sourceLineNo">080</span>     * that the two object graphs are identical.<a name="line.80"></a>
<span class="sourceLineNo">081</span>     *<a name="line.81"></a>
<span class="sourceLineNo">082</span>     * &lt;p&gt;<a name="line.82"></a>
<span class="sourceLineNo">083</span>     * This method must not modify {@code oldRoot} or {@code newRoot} or any other object in their object respective graphs.<a name="line.83"></a>
<span class="sourceLineNo">084</span>     *<a name="line.84"></a>
<span class="sourceLineNo">085</span>     * @param root1 root of first object graph<a name="line.85"></a>
<span class="sourceLineNo">086</span>     * @param root2 root of second object graph<a name="line.86"></a>
<span class="sourceLineNo">087</span>     * @throws IllegalArgumentException if {@code oldRoot} or {@code newRoot} is null<a name="line.87"></a>
<span class="sourceLineNo">088</span>     * @throws PersistentObjectException if an error occurs<a name="line.88"></a>
<span class="sourceLineNo">089</span>     */<a name="line.89"></a>
<span class="sourceLineNo">090</span>    boolean isSameGraph(T root1, T root2);<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span>    /**<a name="line.92"></a>
<span class="sourceLineNo">093</span>     * Validate the given object.<a name="line.93"></a>
<span class="sourceLineNo">094</span>     *<a name="line.94"></a>
<span class="sourceLineNo">095</span>     * &lt;p&gt;<a name="line.95"></a>
<span class="sourceLineNo">096</span>     * This method must not modify {@code obj} or any other object in its object graph.<a name="line.96"></a>
<span class="sourceLineNo">097</span>     *<a name="line.97"></a>
<span class="sourceLineNo">098</span>     * @throws IllegalArgumentException if {@code obj} is null<a name="line.98"></a>
<span class="sourceLineNo">099</span>     * @return set of zero or more constraint violations<a name="line.99"></a>
<span class="sourceLineNo">100</span>     */<a name="line.100"></a>
<span class="sourceLineNo">101</span>    Set&lt;ConstraintViolation&lt;T&gt;&gt; validate(T obj);<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span>    /**<a name="line.103"></a>
<span class="sourceLineNo">104</span>     * Handle an exception thrown during a delayed write-back attempt. {@link ThreadDeath} exceptions are not<a name="line.104"></a>
<span class="sourceLineNo">105</span>     * passed to this method, but all others are.<a name="line.105"></a>
<span class="sourceLineNo">106</span>     *<a name="line.106"></a>
<span class="sourceLineNo">107</span>     * @param pobj the instance that encountered the exception<a name="line.107"></a>
<span class="sourceLineNo">108</span>     * @param t the exception thrown<a name="line.108"></a>
<span class="sourceLineNo">109</span>     */<a name="line.109"></a>
<span class="sourceLineNo">110</span>    void handleWritebackException(PersistentObject&lt;T&gt; pobj, Throwable t);<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span>    /**<a name="line.112"></a>
<span class="sourceLineNo">113</span>     * Get the default value for the root object graph. This method is invoked at startup when the persistent file does not exist.<a name="line.113"></a>
<span class="sourceLineNo">114</span>     * If this method returns null, then an {@linkplain PersistentObject#isAllowEmptyStart empty start} occurs unless the<a name="line.114"></a>
<span class="sourceLineNo">115</span>     * {@link PersistentObject} object is configured to disallow them, in which case an exception is thrown.<a name="line.115"></a>
<span class="sourceLineNo">116</span>     *<a name="line.116"></a>
<span class="sourceLineNo">117</span>     * @return root object initial value, or null if there is no default value<a name="line.117"></a>
<span class="sourceLineNo">118</span>     */<a name="line.118"></a>
<span class="sourceLineNo">119</span>    T getDefaultValue();<a name="line.119"></a>
<span class="sourceLineNo">120</span>}<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>




























































</pre>
</div>
</body>
</html>
